docs: rename "quickstart"/"workshop" to "tutorial" across docs#206
Merged
Conversation
The three documentation entries that were labeled "Prompt Agent quickstart", "Hosted Agent quickstart", and "End-to-end workshop" now read as "Foundry Prompt Agent tutorial", "Hosted or HTTP Agent tutorial", and "End-to-end tutorial" across README.md, plugins/agentops/README.md, AGENTS.md, docs/concepts.md, docs/doctor-explained.md, the agentops-workflow skill (both synced copies), and the H1s plus cross-references inside each tutorial doc. The README description for the end-to-end tutorial now also states explicitly that it extends either of the type-specific tutorials (sandbox -> dev -> qa -> prod plus Foundry red-team scans plus trace-to-regression promotion) so the difference between the three is obvious at a glance. The "quickstart" framing no longer fits doc bodies that grew past 1000 lines covering multi-environment promotion, regression injection, Doctor evidence, and Cockpit. Tutorial filenames are intentionally preserved (tutorial-*-quickstart.md) to keep inbound links and bookmarks stable. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
The PO pointed out that the three documentation entries
use the wrong nouns. Both
tutorial-prompt-agent-quickstart.mdandtutorial-hosted-agent-quickstart.mdare now 768 and 1141 lines longand walk the reader through multi-environment promotion, regression
injection, Doctor evidence, and Cockpit. That is not a "quickstart"
anymore. The PO also dislikes the word "workshop" for the end-to-end
doc.
He also asked how the end-to-end tutorial differs from the
hosted-agent one — the answer is that the end-to-end extends
either of the type-specific tutorials with sandbox → dev → qa → prod
promotion, Foundry red-team scans, and trace-to-regression promotion.
That distinction was not visible from the README's previous description.
What changed
20 edits across 10 files:
README.md(L213–215)docs/tutorial-prompt-agent-quickstart.mddocs/tutorial-hosted-agent-quickstart.mddocs/tutorial-end-to-end.mddocs/concepts.md(L183–189)docs/doctor-explained.md(L6, L414)plugins/agentops/README.md(L84–86)AGENTS.md(L224–226)src/agentops/templates/skills/agentops-workflow/SKILL.md(L65, L305)plugins/agentops/skills/agentops-workflow/SKILL.md(L65, L305)git diffconfirms both copies are identical).CHANGELOG entry added under
### Changedexplaining the wording changeand that filenames are intentionally preserved.
Filenames are intentionally not renamed
tutorial-prompt-agent-quickstart.md,tutorial-hosted-agent-quickstart.md, andtutorial-end-to-end.mdkeep their existing filenames. The "-quickstart" segment is now just a
stable URL slug — renaming the files would break every inbound link
(including external SEO and people's personal bookmarks) for zero
visible benefit, since GitHub renders the H1 inside the page anyway.
Out of scope (deliberately left alone)
examples/flat-quickstart/directory — that's a code example, not atutorial.
## Quickstartsection header insidesrc/agentops/templates/agent-server/README.md— different concept(it's the deploy-as-Copilot-Extension scaffold).
microsoft-foundry-e2e-agent-observability-workshop— externalGitHub repo name, must stay literal.
quickstart-agent:2in YAML fixtures — example agent identifier,not tutorial naming.
Validation
python -m pytest tests/ -x -q— 802 passed, 3 skipped.git diffconfirms bothSKILL.mdcopies got byte-identical edits,so the skill sync stays consistent without needing
./scripts/sync-skills.ps1.Related
landed on
develop.